Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Migrate E/App to use PlatformStackNavigation #49937

Open
wants to merge 61 commits into
base: main
Choose a base branch
from
Open

Migrate E/App to use PlatformStackNavigation #49937

wants to merge 61 commits into from
+1,532 −1,979

Conversation

chrispader
Copy link
Contributor

@chrispader chrispader commented Sep 30, 2024 •
edited
Loading

@mountiny @ishpaul777 @chiragsalian

Details

This PR migrates the App to use PlatformStackNavigation types and navigator components implemented in #37891

Fixed Issues

$ #37891
PROPOSAL: #37891 (comment)

Tests

Offline tests

Same as tests

QA Steps

Same as tests

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@chrispader chrispader requested a review from a team as a code owner September 30, 2024 14:32
@melvin-bot melvin-bot bot requested review from srikarparsi and removed request for a team September 30, 2024 14:32
@melvin-bot Melvin Bot
Copy link

melvin-bot bot commented Sep 30, 2024

@srikarparsi Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@chrispader chrispader changed the title [WIP] Use PlatformStackNavigation in E/App (introduce native-stack navigation on native) [WIP] Use PlatformStackNavigation in E/App (introduce native-stack navigation on mobile) Sep 30, 2024
@chrispader chrispader changed the title [WIP] Use PlatformStackNavigation in E/App (introduce native-stack navigation on mobile) [WIP] Migrate E/App to use PlatformStackNavigation Sep 30, 2024
@kirillzyusko kirillzyusko mentioned this pull request Sep 30, 2024
Merged
48 tasks
@chrispader chrispader changed the title [WIP] Migrate E/App to use PlatformStackNavigation [HOLD on #37891] Migrate E/App to use PlatformStackNavigation Sep 30, 2024
@chrispader chrispader force-pushed the @chrispader/use-platform-stack-navigation-in-app branch from 3b921d3 to 5701c46 Compare September 30, 2024 16:30
@srikarparsi
Copy link
Contributor

Re-assigning to @chiragsalian and @mountiny for review since it looks like they have more context.

@srikarparsi srikarparsi requested review from chiragsalian and mountiny and removed request for srikarparsi September 30, 2024 16:50
@chrispader
Copy link
Contributor Author

@mountiny or @chiragsalian please from now on create ad-hoc builds from here. I fixed all remaining reported errors yesterday, so we can probably trigger a new build already.

@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@chrispader
Copy link
Contributor Author

The ad-hoc iOS build fail is also going to be related to the patch from #49936

@ishpaul777
Copy link
Contributor

@mountiny Please run adhoc builds here when you have a moment, i plan to work on testing this fully today

@mountiny
Copy link
Contributor

mountiny commented Oct 3, 2024

Running

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 3, 2024

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
❌ FAILED ❌ ❌ FAILED ❌
The QR code can't be generated, because the android build failed The QR code can't be generated, because the iOS build failed
Desktop 💻 Web 🕸️
❌ FAILED ❌ https://49937.pr-testing.expensify.com
The QR code can't be generated, because the Desktop build failed Web

👀 View the workflow run that generated this build 👀

@chrispader
Copy link
Contributor Author

@mountiny Please run adhoc builds here when you have a moment, i plan to work on testing this fully today

The PR didn't have the changes to the react-native-vision-camera patches up until now. Please trigger another set of ad-hoc builds :)

@mountiny
Copy link
Contributor

mountiny commented Oct 4, 2024

https://github.com/Expensify/App/actions/runs/11179336829

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 4, 2024

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/49937/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/49937/index.html
Android iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/49937/NewExpensify.dmg https://49937.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@mountiny
Copy link
Contributor

mountiny commented Oct 4, 2024

Bug on the workspace page
IMG_6525

@mountiny
Copy link
Contributor

mountiny commented Oct 4, 2024 •
edited
Loading

@chrispader Looking great! I think there are two things I have noticed:

  1. There is a noticeable delay of idk 0.5s after clicking on the chat row for the animation to start
  2. The chat finder modal is opening from the bottom, we want to keep the same animation we have now in main - animating from left

ishpaul777
ishpaul777 reviewed Oct 4, 2024
View reviewed changes
package-lock.json Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

commenting so this shows on my k2 for easy access

@chrispader
Copy link
Contributor Author

chrispader commented Oct 6, 2024 •
edited
Loading

Bug on the workspace page

@chrispader Looking great! I think there are two things I have noticed:

  1. There is a noticeable delay of idk 0.5s after clicking on the chat row for the animation to start
  2. The chat finder modal is opening from the bottom, we want to keep the same animation we have now in main - animating from left

@mountiny Both bugs are fixed!

I couldn't really see a difference between Stack navigator and Native-Stack while testing in this PR: (you meant when clicking on an item in the Sidebar right?)

Stack

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-10-06.at.17.38.30.mp4

Native Stack

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-10-06.at.20.09.51.mp4

@chrispader
Copy link
Contributor Author

I will be OOO the next week, but i will hand this over to one of our other Margelo engineers. If there are any urgent issues i can also help with that, but i'm not gonna be on my Macbook unfortunately

@ishpaul777
Copy link
Contributor

ishpaul777 commented Oct 6, 2024 •
edited
Loading

I am now available for around ~2 hours i'll pull and start testing this locally

@chrispader
Copy link
Contributor Author

The "Expensify / Search" top bar area is jittery when tapping on the search bottom tab. The "Expensify" and workspace switcher icon flash. Doesn't seem like that's the case when clicking the Inbox bottom tab.

I don't think i can reproduce this. @trjExpensify what do you mean by jittery? If you mean the "flashing" of the Expensify logo and text, this is just caused because we effectively render a new screen and the header component is not shared between screens. Since we load the other Bottom Tabs Screens lazily, this might take a few ms on the initial render.

What i notice though, is that navigating to the bottom tab "Search" takes a bit longer than the other tabs. Though, this might just be due to more content to be (initially) rendered.

ScreenRecording_11-11-2024.14-29-38_1.MP4

@chrispader
Copy link
Contributor Author

Status page is pretty slow to focus the empty field input (the keyboard opening specifically). Seems quite a bit faster on the NewDot standalone app.

I also cannot reproduce the slowness of the Status page. The empty field is focused once the screen finished animating in.

NewDot TestFlight This PR
ScreenRecording_11-11-2024.14-34-14_1.MP4
ScreenRecording_11-11-2024.14-33-15_1.MP4

@chrispader
Copy link
Contributor Author

  • The "Expensify / Search" top bar area is jittery when tapping on the search bottom tab. The "Expensify" and workspace switcher icon flash. Doesn't seem like that's the case when clicking the Inbox bottom tab.

  • When switching to the Settings bottom tab, the account avatar noticeably flashes.

The flashes of the header can be improved by loading the bottom tab screens (in this case InitialSettingsPage) directly on startup, rather than lazily. This will increase startup time by a bit, but it think it's better than having these flashes.

Right now i cannot really see any big flashes though:

NewDot on main This PR
Simulator.Screen.Recording.-.iPhone.16.-.2024-11-11.at.15.28.10.mp4
Untitled.mp4

@chrispader
Copy link
Contributor Author

LHN bottom tab "Inbox" and "Serach" icon missing the label

Fixed. The BottomTabBar component was just outdated

@trjExpensify
Copy link
Contributor

I don't think i can reproduce this. @trjExpensify what do you mean by jittery? If you mean the "flashing" of the Expensify logo and text

Yeah, on Friday it seemed like the Expensify logo and text was shaking more than just flashing. Retesting today on the same build and it seems a lot better. Even the flashing seems to have gone? 🤔

@mountiny
Copy link
Contributor

on Friday it seemed like the Expensify logo and text was shaking more than just flashing

Did you test it from a bar by any chance @trjExpensify?

@trjExpensify
Copy link
Contributor

Did you test it from a bar by any chance @trjExpensify?

rofl. Surprisingly, no.

@chrispader
Copy link
Contributor Author

Ios, in Onboarding flow after selecting user intent the next screen pops up from bottom of screen

Fixed.

While Switching workspace for breif moment there is blank screen

Fixed in 8e78f30. @mountiny this change introduces some new workspace switching/navigation logic, so please give this change a quick review :)

@chrispader
Copy link
Contributor Author

chrispader commented Nov 12, 2024 •
edited
Loading

Bug: White screen blink when Deleting from Confirm modal.
Create a workspace-> Go to Categories/tags. -> Create a Catgory -> Click on created Catgory -> Delete
Also reproducable when onboarding flow is finished and user is navigated.

I can confirm this has been fixed by the react-native-screens patch by @WoLewicki from software-mansion/react-native-screens#2485 fixed this issue.

The modal will not animate out while the screen unmounts, but it still looks acceptable imo:

Without patch With patch
ScreenRecording_11-12-2024.15-25-02_1.MP4
ScreenRecording_11-12-2024.15-44-30_1.MP4

@chrispader
Copy link
Contributor Author

chrispader commented Nov 12, 2024 •
edited
Loading

Android:

  • screen is half cut off when navigating to details page when keyboard is open

As of right now, this is the last (major) issue with this PR.

This also seems to be a low-level problem with react-native-screens on Android only.

@WoLewicki could you possibly also take a look at this issue? This Android issue also most certainly stems from react-native-screens. I've tried debugging RNS and think this has something to do with the layout measurements under Fabric, but i couldn't figure out the problem since i'm not very familiar with the codebase.

@WoLewicki do you maybe have some spare cycles to take a look at this issue in react-native-screens? Atm this is the only issue blocking this PR 🙌

@ishpaul777
Copy link
Contributor

ishpaul777 commented Nov 12, 2024 •
edited
Loading

Heads up! I'll be out till friday, will be back on Saturday and will review and test whatever we have over the weekend. Sorry if it cause any delay on my part 🙇

@mountiny
Copy link
Contributor

@chrispader yeah that animation looks good to me

@mountiny
Copy link
Contributor

What are the remaining known issues @ishpaul777 @chrispader ?

WoLewicki added a commit to software-mansion/react-native-screens that referenced this pull request Nov 14, 2024
@WoLewicki
fix: remove unnecessary checks for creating snapshot (#2485)
7549b19 
## Description

Based on
Expensify/App#49937 (comment) and
the comments above, PR fixes the unnecessary checks for creating
snapshot on the view on dismiss. It was refactored already in
#2134 and
#2261 (👏 to
@kkafar). Those checks do nothing now since each screen is responsible
for making its own snapshot. Having those checks can only lead to
problems.
@github-actions GitHub Actions
Copy link
Contributor

🚧 @mountiny has triggered a test build. You can view the workflow run here.

@github-actions GitHub Actions
Copy link
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/49937/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/49937/index.html
Android iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/49937/NewExpensify.dmg https://49937.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ishpaul777 ishpaul777 ishpaul777 left review comments

@kirillzyusko kirillzyusko kirillzyusko left review comments

@mountiny mountiny Awaiting requested review from mountiny

@youssef-lr youssef-lr Awaiting requested review from youssef-lr

At least 1 approving review is required to merge this pull request.

Assignees

@chrispader chrispader

Labels
Ready To Build
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
10 participants
@chrispader @srikarparsi @ishpaul777 @mountiny @kirillzyusko @youssef-lr @dannymcclain @WoLewicki @chiragsalian @trjExpensify